<?php
namespace org\crawlgenie\application\database;
use \Logger;
use \CGException;


/**
 *  DatabaseCore Class
 *
 *  $Author:$:
 *  $Date$:
 *  $Id$:
 *  @version $Rev$:
 *  @package crawlgenie.application
 *  @subpackage database
 */



define('DATABASE_VERSION','1.0');
define('OBJECT','OBJECT',true);
define('ARRAY_A','ARRAY_A',true);
define('ARRAY_N','ARRAY_N',true);
define('DATABASECORE_ERROR','DatabaseCore cannot be used by itself (it is designed for use by database specific subclasses).');


    /**********************************************************************
    *  Core class containg common functions to manipulate query result
    *  sets once returned
    */

    abstract class DatabaseCore {

        protected $trace            = false;  // same as $debug_all
        protected $use_trace_log    = false;
        protected $trace_log        = array();
        protected $debug_all        = false;  // same as $trace
        protected $debug_called     = false;
        protected $protecteddump_called   = false;
        protected $show_errors      = true;
        public    $num_queries      = 0;
        protected $rowsAffected     = 0;
        protected $last_result      = null;
        protected $last_query       = null;
        protected $last_error       = null;
        protected $col_info         = null;
        protected $captured_errors  = array();
        protected $cache_dir        = false;
        protected $cache_queries    = false;
        protected $cache_inserts    = false;
        protected $use_disk_cache   = false;
        protected $from_disk_cache  = false;
        protected $cache_timeout    = 24; // hours


        // == TJH == default now needed for echo of debug function
        protected $debug_echo_is_on = true;

        /**********************************************************************
        *  Constructor
        */

        abstract public function __construct();


        /**********************************************************************
        *  Connect to DB
        */
        abstract protected function connect();


        /**
         * Basic Query
         */
        abstract protected function query(/*string*/$query);



        /**
         *  Format a string correctly for safe insert
         */
        abstract public function escape(/*string*/$str);


        /**
         *
         *  Return database specific system date syntax
         *  i.e. Oracle: SYSDATE Mysql: NOW()
         */
        abstract public function sysdate();


        /**
         *  Print SQL/DB error
         */
        protected function registerError($errStr) {
            // Keep track of last error
            $this->last_error = $errStr;

            // Capture all errors to an error array no matter what happens
            $this->captured_errors[] = array('error_str' => $errStr, 'query' => $this->last_query);
        }

        
        /**
         *  Turn error handling on
         */
        public function showErrors() {
            $this->show_errors = true;
        }

        /**
         *  Turn error handling off
         */
        public function hideErrors() {
            $this->show_errors = false;
        }


        /**
         *  Kill cached query results
         */
        protected function flush() {
            // Get rid of these
            $this->last_result = array();
            $this->col_info = null;
            $this->last_query = null;
            $this->from_disk_cache = false;
        }

        
        /**
         *  Begin Transaction
         */
        abstract protected function beginTransaction();


        /**
         *  End Transaction
         */
        abstract protected function endTransaction();



        /**
         * Number of rows affected for the last query
         */
         public function getRowsAffected() {
             return $this->rowsAffected;
         }


        /**
        *  Get one variable from the DB - see docs for more detail
        */
        public function getVar($query=null, $x=0, $y=0) {
//        print '<br />getVar called. Lets see the last_result var contents:<br />';
//               var_dump($this->last_result).'<br /><br />';
            // Log how the function was called
            $this->func_call = "\$db->getVar(\"$query\",$x,$y)";

            // If there is a query then perform it if not then use cached results..
            if ($query) {
                $this->query($query);
            }

            // Extract var out of cached results based x,y vals
            if (isset($this->last_result[$y])) {
                $values = array_values(get_object_vars($this->last_result[$y]));
            }

            // If there is a value return it else return null
            return (isset($values[$x]) && $values[$x]!='') ? $values[$x] : null;
        }


        /**
         *  Get one row from the DB - see docs for more detail
         */
        public function getRow($query=null, $output=OBJECT,$y=0) {
//                    print '<br />getRow called. Lets see the last_result var contents:<br />';
//                    var_dump($this->last_result).'<br /><br />';

            // Log how the function was called
            $this->func_call = "\$db->get_row(\"$query\",$output,$y)";

            // If there is a query then perform it if not then use cached results..
            if ($query) {
                $this->query($query);
            }

            // If the output is an object then return object using the row offset..
            if ($output == OBJECT) {
                return isset($this->last_result[$y]) ? $this->last_result[$y] : null;

            } elseif ($output == ARRAY_A) {
                return isset($this->last_result[$y]) ? get_object_vars($this->last_result[$y]) : null;

            } elseif ( $output == ARRAY_N ) {
                return isset($this->last_result[$y]) ? array_values(get_object_vars($this->last_result[$y])) : null;

            } else {
                $this->print_error(" \$db->get_row(string query, output type, int offset) -- Output type must be one of: OBJECT, ARRAY_A, ARRAY_N");
            }
        }

        /**
         *  Function to get 1 column from the cached result set based in X index
         *  see docs for usage and info
         */
        public function getCol($query=null, $x=0) {
            // If there is a query then perform it if not then use cached results..
            if ($query) {
                $this->query($query);
            }

            // Extract the column values
            $totalRows = count($this->last_result);
            for ($i=0; $i < $totalRows; $i++) {
                $newArray[$i] = $this->getVar(null,$x,$i);
            }

            return $newArray;
        }



        
        public function getResults() {
            $returnArray = array(); //we want to return an array of objects.
            
            foreach($this->last_result as $row) {
                $returnArray[] = $row;
            }

            return $returnArray;                
        }


        /**********************************************************************
        *  Function to get column meta data info pertaining to the last query
        * see docs for more info and usage
        */

        public function getColInfo($info_type="name",$colOffset=-1)
        {

                if ( $this->col_info )
                {
                        if ( $colOffset == -1 )
                        {
                                $i=0;
                                foreach($this->col_info as $col )
                                {
                                        $newArray[$i] = $col->{$info_type};
                                        $i++;
                                }
                                return $newArray;
                        }
                        else
                        {
                                return $this->col_info[$colOffset]->{$info_type};
                        }

                }

        }

        /**********************************************************************
        *  store_cache
        */

        protected function storeCache($query,$isInsert)
        {

                // The would be cache file for this query
                $cache_file = $this->cache_dir.'/'.md5($query);

                // disk caching of queries
                if ( $this->use_disk_cache && ( $this->cache_queries && ! $isInsert ) || ( $this->cache_inserts && $isInsert ))
                {
                        if ( ! is_dir($this->cache_dir) )
                        {
                                $this->registerError("Could not open cache dir: $this->cache_dir");
                                $this->show_errors ? trigger_error("Could not open cache dir: $this->cache_dir",E_USER_WARNING) : null;
                        }
                        else
                        {
                                // Cache all result values
                                $resultCache = array
                                (
                                        'col_info' => $this->col_info,
                                        'last_result' => $this->last_result,
                                        'num_rows' => $this->num_rows,
                                        'return_value' => $this->num_rows,
                                );
                                error_log ( serialize($resultCache), 3, $cache_file);
                        }
                }

        }

        /**********************************************************************
        *  get_cache
        */

        protected function getCache($query)
        {

                // The would be cache file for this query
                $cache_file = $this->cache_dir.'/'.md5($query);

                // Try to get previously cached version
                if ( $this->use_disk_cache && file_exists($cache_file) )
                {
                        // Only use this cache file if less than 'cache_timeout' (hours)
                        if ( (time() - filemtime($cache_file)) > ($this->cache_timeout*3600) )
                        {
                                unlink($cache_file);
                        }
                        else
                        {
                                $resultCache = unserialize(file_get_contents($cache_file));

                                $this->col_info = $resultCache['col_info'];
                                $this->last_result = $resultCache['last_result'];
                                $this->num_rows = $resultCache['num_rows'];

                                $this->from_disk_cache = true;

                                // If debug ALL queries
                                $this->trace || $this->debug_all ? $this->debug() : null ;

                                return $resultCache['return_value'];
                        }
                }

        }

        /**********************************************************************
        *  Dumps the contents of any input variable to screen in a nicely
        *  formatted and easy to understand way - any type: Object, Var or Array
        */

        public function vardump($mixed='')
        {

                // Start output buffering
                ob_start();

                echo "<p><table><tr><td bgcolor=ffffff><blockquote><font color=000090>";
                echo "<pre><font face=arial>";

                if ( ! $this->vardump_called )
                {
                        echo "<font color=800080><b>Database</b> (v".DATABASE_VERSION.") <b>Variable Dump..</b></font>\n\n";
                }

                $var_type = gettype ($mixed);
                print_r(($mixed?$mixed:"<font color=red>No Value / False</font>"));
                echo "\n\n<b>Type:</b> " . ucfirst($var_type) . "\n";
                echo "<b>Last Query</b> [$this->num_queries]<b>:</b> ".($this->last_query?$this->last_query:"NULL")."\n";
                echo "<b>Last Function Call:</b> " . ($this->func_call?$this->func_call:"None")."\n";
                echo "<b>Last Rows Returned:</b> ".count($this->last_result)."\n";
                echo "\n<hr size=1 noshade color=dddddd>";

                // Stop output buffering and capture debug HTML
                $html = ob_get_contents();
                ob_end_clean();

                // Only echo output if it is turned on
                if ( $this->debug_echo_is_on )
                {
                        echo $html;
                }

                $this->vardump_called = true;

                return $html;

        }


        /**********************************************************************
        *  Displays the last query string that was sent to the database & a
        * table listing results (if there were any).
        * (abstracted into a separate file to save server overhead).
        */

        public function debug()
        {

                // Start outup buffering
                ob_start();

                echo "<blockquote>";

                // Only show ezSQL credits once..
                if ( ! $this->debug_called )
                {
                        echo "<font color=800080 face=arial size=2><b>Database</b> (v".DATABASE_VERSION.") <b>Debug..</b></font><p>\n";
                }

                if ( $this->last_error )
                {
                        echo "<font face=arial size=2 color=000099><b>Last Error --</b> [<font color=000000><b>$this->last_error</b></font>]<p>";
                }

                if ( $this->from_disk_cache )
                {
                        echo "<font face=arial size=2 color=000099><b>Results retrieved from disk cache</b></font><p>";
                }

                echo "<font face=arial size=2 color=000099><b>Query</b> [$this->num_queries] <b>--</b> ";
                echo "[<font color=000000><b>$this->last_query</b></font>]</font><p>";

                        echo "<font face=arial size=2 color=000099><b>Query Result..</b></font>";
                        echo "<blockquote>";

                if ( $this->col_info )
                {

                        // =====================================================
                        // Results top rows

                        echo "<table cellpadding=5 cellspacing=1 bgcolor=555555>";
                        echo "<tr bgcolor=eeeeee><td nowrap valign=bottom><font color=555599 face=arial size=2><b>(row)</b></font></td>";


                        for ( $i=0; $i < count($this->col_info); $i++ )
                        {
                                echo "<td nowrap align=left valign=top><font size=1 color=555599 face=arial>{$this->col_info[$i]->type} {$this->col_info[$i]->max_length}</font><br><span style='font-family: arial; font-size: 10pt; font-weight: bold;'>{$this->col_info[$i]->name}</span></td>";
                        }

                        echo "</tr>";

                        // ======================================================
                        // print main results

                if ( $this->last_result )
                {

                        $i=0;
                        foreach ( $this->getResults() as $one_row )
                        {
                                $i++;
                                echo "<tr bgcolor=ffffff><td bgcolor=eeeeee nowrap align=middle><font size=2 color=555599 face=arial>$i</font></td>";

                                foreach ( $one_row as $item )
                                {
                                        echo "<td nowrap><font face=arial size=2>$item</font></td>";
                                }

                                echo "</tr>";
                        }

                } // if last result
                else
                {
                        echo "<tr bgcolor=ffffff><td colspan=".(count($this->col_info)+1)."><font face=arial size=2>No Results</font></td></tr>";
                }

                echo "</table>";

                } // if col_info
                else
                {
                        echo "<font face=arial size=2>No Results</font>";
                }

                // Stop output buffering and capture debug HTML
                $html = ob_get_contents();
                ob_end_clean();

                // Only echo output if it is turned on
                if ( $this->debug_echo_is_on )
                {
                        echo $html;
                }

                $this->debug_called = true;

                return $html;

        }

    }

?>